home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XAllocIconSize.z / XAllocIconSize
Encoding:
Text File  |  1998-10-30  |  5.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXAAAAllllllllooooccccIIIIccccoooonnnnSSSSiiiizzzzeeee((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXAAAAllllllllooooccccIIIIccccoooonnnnSSSSiiiizzzzeeee((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XAllocIconSize, XSetIconSizes, XGetIconSizes, XIconSize -
  10.           allocate icon size structure and set or read a window's
  11.           WM_ICON_SIZES property
  12.  
  13.      SSSSYYYYNNNNTTTTAAAAXXXX
  14.           XIconSize *XAllocIconSize()
  15.  
  16.           XSetIconSizes(_d_i_s_p_l_a_y, _w, _s_i_z_e__l_i_s_t, _c_o_u_n_t)
  17.                 Display *_d_i_s_p_l_a_y;
  18.                 Window _w;
  19.                 XIconSize *_s_i_z_e__l_i_s_t;
  20.                 int _c_o_u_n_t;
  21.  
  22.           Status XGetIconSizes(_d_i_s_p_l_a_y, _w, _s_i_z_e__l_i_s_t__r_e_t_u_r_n,
  23.           _c_o_u_n_t__r_e_t_u_r_n)
  24.                 Display *_d_i_s_p_l_a_y;
  25.                 Window _w;
  26.                 XIconSize **_s_i_z_e__l_i_s_t__r_e_t_u_r_n;
  27.                 int *_c_o_u_n_t__r_e_t_u_r_n;
  28.  
  29.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  30.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  31.  
  32.           _c_o_u_n_t     Specifies the number of items in the size list.
  33.  
  34.           _c_o_u_n_t__r_e_t_u_r_n
  35.                     Returns the number of items in the size list.
  36.  
  37.           _s_i_z_e__l_i_s_t Specifies the size list.
  38.  
  39.           _s_i_z_e__l_i_s_t__r_e_t_u_r_n
  40.                     Returns the size list.
  41.  
  42.           _w         Specifies the window.
  43.  
  44.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  45.           The _X_A_l_l_o_c_I_c_o_n_S_i_z_e function allocates and returns a pointer
  46.           to a _X_I_c_o_n_S_i_z_e structure.  Note that all fields in the
  47.           _X_I_c_o_n_S_i_z_e structure are initially set to zero.  If
  48.           insufficient memory is available, _X_A_l_l_o_c_I_c_o_n_S_i_z_e returns
  49.           NULL.  To free the memory allocated to this structure, use
  50.           _X_F_r_e_e.
  51.  
  52.           The _X_S_e_t_I_c_o_n_S_i_z_e_s function is used only by window managers
  53.           to set the supported icon sizes.
  54.  
  55.           _X_S_e_t_I_c_o_n_S_i_z_e_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
  56.  
  57.           The _X_G_e_t_I_c_o_n_S_i_z_e_s function returns zero if a window manager
  58.           has not set icon sizes; otherwise, it return nonzero.
  59.           _X_G_e_t_I_c_o_n_S_i_z_e_s should be called by an application that wants
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXAAAAllllllllooooccccIIIIccccoooonnnnSSSSiiiizzzzeeee((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXAAAAllllllllooooccccIIIIccccoooonnnnSSSSiiiizzzzeeee((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           to find out what icon sizes would be most appreciated by the
  75.           window manager under which the application is running.  The
  76.           application should then use _X_S_e_t_W_M_H_i_n_t_s to supply the window
  77.           manager with an icon pixmap or window in one of the
  78.           supported sizes.  To free the data allocated in
  79.           size_list_return, use _X_F_r_e_e.
  80.  
  81.           _X_G_e_t_I_c_o_n_S_i_z_e_s can generate a _B_a_d_W_i_n_d_o_w error.
  82.  
  83.      PPPPRRRROOOOPPPPEEEERRRRTTTTIIIIEEEESSSS
  84.           WM_ICON_SIZES
  85.                     The window manager may set this property on the
  86.                     root window to specify the icon sizes it supports.
  87.                     The C type of this property is _X_I_c_o_n_S_i_z_e.
  88.  
  89.      SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS
  90.           The _X_I_c_o_n_S_i_z_e structure contains:
  91.  
  92.           typedef struct {
  93.                int min_width, min_height;
  94.                int max_width, max_height;
  95.                int width_inc, height_inc;
  96.           } XIconSize;
  97.  
  98.           The width_inc and height_inc members define an arithmetic
  99.           progression of sizes (minimum to maximum) that represent the
  100.           supported icon sizes.
  101.  
  102.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  103.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  104.                     resource or server memory.
  105.  
  106.           _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  107.                     defined Window.
  108.  
  109.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  110.           XAllocClassHint(3X11), XAllocSizeHints(3X11),
  111.           XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11),
  112.           XSetTransientForHint(3X11), XSetTextProperty(3X11),
  113.           XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11),
  114.           XSetWMIconName(3X11), XSetWMName(3X11),
  115.           XSetWMProperties(3X11), XSetWMProtocols(3X11),
  116.           XStringListToTextProperty(3X11)
  117.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.